Skip to content

Latest commit

 

History

History
175 lines (125 loc) · 6.78 KB

MemberPrivacyApi.md

File metadata and controls

175 lines (125 loc) · 6.78 KB

sparkfly_client.MemberPrivacyApi

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

Method HTTP request Description
create_member_deletion_request POST /v1.0/privacy/member/delete_request Creates a deletion request for a member
export_member_data GET /v1.0/privacy/member/export Exports data associated with a member

create_member_deletion_request

create_member_deletion_request(credential_identifier=credential_identifier, member_identifier=member_identifier)

Creates a deletion request for a member

Looks up and creates a deletion request for the member associated with the provided member_identifier or credential_identifier query parameter. For each deletion request, all member offers will first be voided, then after 7 days, or longer if specified in an Account's preferences, the member will be anonymized.

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.MemberPrivacyApi(api_client)
    credential_identifier = 'credential_identifier_example' # str | The identifier of the credential (optional)
    member_identifier = 'member_identifier_example' # str | The identifier of the member (optional)

    try:
        # Creates a deletion request for a member
        api_instance.create_member_deletion_request(credential_identifier=credential_identifier, member_identifier=member_identifier)
    except Exception as e:
        print("Exception when calling MemberPrivacyApi->create_member_deletion_request: %s\n" % e)

Parameters

Name Type Description Notes
credential_identifier str The identifier of the credential [optional]
member_identifier str The identifier of the member [optional]

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 Successfully created a member deletion request -
401 Unauthorized -
400 Bad request -
422 Member could not be located from the member or credential identifiers -
500 Internal issue creating a member deletion request -

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

export_member_data

MemberExportData export_member_data(credential_identifier=credential_identifier, member_identifier=member_identifier)

Exports data associated with a member

Looks up and exports data for the member associated with the provided member_identifier or credential_identifier query parameter.

Example

  • Api Key Authentication (X-Auth-Token):
import time
import os
import sparkfly_client
from sparkfly_client.models.member_export_data import MemberExportData
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.MemberPrivacyApi(api_client)
    credential_identifier = 'credential_identifier_example' # str | The identifier of the credential (optional)
    member_identifier = 'member_identifier_example' # str | The identifier of the member (optional)

    try:
        # Exports data associated with a member
        api_response = api_instance.export_member_data(credential_identifier=credential_identifier, member_identifier=member_identifier)
        print("The response of MemberPrivacyApi->export_member_data:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MemberPrivacyApi->export_member_data: %s\n" % e)

Parameters

Name Type Description Notes
credential_identifier str The identifier of the credential [optional]
member_identifier str The identifier of the member [optional]

Return type

MemberExportData

Authorization

X-Auth-Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successfully responded with exported data for a member -
401 Unauthorized -
400 Bad request -
422 Member could not be located from the member or credential identifiers -
500 Internal issue exporting member data -

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