sparkfly_client.MemberListsApi

All URIs are relative to https://api.sparkfly.com

Method	HTTP request	Description
create_member_list	POST /v1.0/member_lists	Create a member list
delete_member_list	DELETE /v1.0/member_lists/{member_list_id}	Delete Member List by ID
get_member_list	GET /v1.0/member_lists/{member_list_id}	Get member list by ID
get_member_lists	GET /v1.0/member_lists	Get all member lists
update_member_list	PUT /v1.0/member_lists/{member_list_id}	Update Member List by ID

create_member_list

MemberListObjectResponse create_member_list(member_list_input_request=member_list_input_request)

Create a member list

Example

Api Key Authentication (X-Auth-Token):

import time
import os
import sparkfly_client
from sparkfly_client.models.member_list_input_request import MemberListInputRequest
from sparkfly_client.models.member_list_object_response import MemberListObjectResponse
from sparkfly_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.sparkfly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = sparkfly_client.Configuration(
    host = "https://api.sparkfly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: X-Auth-Token
configuration.api_key['X-Auth-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with sparkfly_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sparkfly_client.MemberListsApi(api_client)
    member_list_input_request = sparkfly_client.MemberListInputRequest() # MemberListInputRequest | Member list to add to system (optional)

    try:
        # Create a member list
        api_response = api_instance.create_member_list(member_list_input_request=member_list_input_request)
        print("The response of MemberListsApi->create_member_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MemberListsApi->create_member_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
member_list_input_request	MemberListInputRequest	Member list to add to system	[optional]

Return type

MemberListObjectResponse

Authorization

X-Auth-Token

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Successful creation	* Cache-Control - * Content-Length - * Content-Type - * Date - * Etag - * Location - * Server - * Set-Cookie - * X-Request-Id - * X-Runtime - * X-Ua-Compatible -
400	Error parsing request	* Cache-Control - * Content-Length - * Content-Type - * Date - * Server - * Set-Cookie - * X-Request-Id - * X-Runtime - * X-Ua-Compatible -
401	Unauthorized	* Cache-Control - * Content-Length - * Content-Type - * Date - * Server - * X-Request-Id - * X-Runtime - * X-Ua-Compatible -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_member_list

delete_member_list(member_list_id)

Delete Member List by ID

Example

Api Key Authentication (X-Auth-Token):

import time
import os
import sparkfly_client
from sparkfly_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.sparkfly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = sparkfly_client.Configuration(
    host = "https://api.sparkfly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: X-Auth-Token
configuration.api_key['X-Auth-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with sparkfly_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sparkfly_client.MemberListsApi(api_client)
    member_list_id = 56 # int | The id of the member list

    try:
        # Delete Member List by ID
        api_instance.delete_member_list(member_list_id)
    except Exception as e:
        print("Exception when calling MemberListsApi->delete_member_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
member_list_id	int	The id of the member list

Return type

void (empty response body)

Authorization

X-Auth-Token

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Successful deletion	* Cache-Control - * Content-Length - * Content-Type - * Date - * Etag - * Server - * Set-Cookie - * X-Request-Id - * X-Runtime - * X-Ua-Compatible -
401	Unauthorized	* Cache-Control - * Content-Length - * Content-Type - * Date - * Server - * X-Request-Id - * X-Runtime - * X-Ua-Compatible -
404	Member List was not found by id	* Cache-Control - * Content-Length - * Content-Type - * Date - * Server - * Set-Cookie - * X-Request-Id - * X-Runtime - * X-Ua-Compatible -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_member_list

MemberListObjectResponse get_member_list(member_list_id)

Get member list by ID

Example

Api Key Authentication (X-Auth-Token):

import time
import os
import sparkfly_client
from sparkfly_client.models.member_list_object_response import MemberListObjectResponse
from sparkfly_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.sparkfly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = sparkfly_client.Configuration(
    host = "https://api.sparkfly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: X-Auth-Token
configuration.api_key['X-Auth-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with sparkfly_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sparkfly_client.MemberListsApi(api_client)
    member_list_id = 56 # int | The id of the member list

    try:
        # Get member list by ID
        api_response = api_instance.get_member_list(member_list_id)
        print("The response of MemberListsApi->get_member_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MemberListsApi->get_member_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
member_list_id	int	The id of the member list

Return type

MemberListObjectResponse

Authorization

X-Auth-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	member list to be returned	* Cache-Control - * Content-Length - * Date - * Etag - * Server - * Set-Cookie - * X-Auth-Token - * X-Request-Id - * X-Runtime - * X-Ua-Compatible -
401	Unauthorized	* Cache-Control - * Content-Length - * Content-Type - * Date - * Server - * X-Request-Id - * X-Runtime - * X-Ua-Compatible -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_member_lists

MemberListList get_member_lists()

Get all member lists

Example

Api Key Authentication (X-Auth-Token):

import time
import os
import sparkfly_client
from sparkfly_client.models.member_list_list import MemberListList
from sparkfly_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.sparkfly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = sparkfly_client.Configuration(
    host = "https://api.sparkfly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: X-Auth-Token
configuration.api_key['X-Auth-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with sparkfly_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sparkfly_client.MemberListsApi(api_client)

    try:
        # Get all member lists
        api_response = api_instance.get_member_lists()
        print("The response of MemberListsApi->get_member_lists:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MemberListsApi->get_member_lists: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

MemberListList

Authorization

X-Auth-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	member lists to be returned	* Cache-Control - * Content-Length - * Date - * Etag - * Server - * Set-Cookie - * X-Auth-Token - * X-Request-Id - * X-Runtime - * X-Ua-Compatible -
401	Unauthorized	* Cache-Control - * Content-Length - * Content-Type - * Date - * Server - * X-Request-Id - * X-Runtime - * X-Ua-Compatible -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_member_list

MemberListObjectResponse update_member_list(member_list_id, member_list_input_request=member_list_input_request)

Update Member List by ID

Example

Api Key Authentication (X-Auth-Token):

import time
import os
import sparkfly_client
from sparkfly_client.models.member_list_input_request import MemberListInputRequest
from sparkfly_client.models.member_list_object_response import MemberListObjectResponse
from sparkfly_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.sparkfly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = sparkfly_client.Configuration(
    host = "https://api.sparkfly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: X-Auth-Token
configuration.api_key['X-Auth-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with sparkfly_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sparkfly_client.MemberListsApi(api_client)
    member_list_id = 56 # int | The id of the member list
    member_list_input_request = sparkfly_client.MemberListInputRequest() # MemberListInputRequest | Member List to add to system (optional)

    try:
        # Update Member List by ID
        api_response = api_instance.update_member_list(member_list_id, member_list_input_request=member_list_input_request)
        print("The response of MemberListsApi->update_member_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MemberListsApi->update_member_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
member_list_id	int	The id of the member list
member_list_input_request	MemberListInputRequest	Member List to add to system	[optional]

Return type

MemberListObjectResponse

Authorization

X-Auth-Token

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	updated Member List	* Cache-Control - * Content-Length - * Date - * Etag - * Server - * Set-Cookie - * X-Auth-Token - * X-Request-Id - * X-Runtime - * X-Ua-Compatible -
400	Error parsing request	* Cache-Control - * Content-Length - * Content-Type - * Date - * Server - * Set-Cookie - * X-Request-Id - * X-Runtime - * X-Ua-Compatible -
401	Unauthorized	* Cache-Control - * Content-Length - * Content-Type - * Date - * Server - * X-Request-Id - * X-Runtime - * X-Ua-Compatible -
404	Item set was not found by id	* Cache-Control - * Content-Length - * Content-Type - * Date - * Server - * Set-Cookie - * X-Request-Id - * X-Runtime - * X-Ua-Compatible -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

MemberListsApi.md

Latest commit

History

MemberListsApi.md

File metadata and controls

sparkfly_client.MemberListsApi

create_member_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_member_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_member_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_member_lists

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_member_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details