sparkfly_client.OfferEngineApi

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

Method	HTTP request	Description
check_in_member_to_store	POST /v1.0/members/{member_id}/stores/{store_id}/check-in	Check-In Member to Store
get_member_offer_activities	GET /v1.0/activities/offers	Retrieve Offer Activities for Member
get_member_redemptions	GET /v1.0/members/{member_id}/activities/redemptions	Retrieve Redeemed Redemptions for Member
get_member_store	GET /v1.0/members/{member_id}/stores/{store_id}	Retrieve Store for Member
get_member_store_redemptions	GET /v1.0/members/{member_id}/stores/{store_id}/activities/redemptions	Retrieve Redeemed Redemptions for Member for Store

check_in_member_to_store

check_in_member_to_store(member_id, store_id, check_in_lat, check_in_lng)

Check-In Member to Store

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.OfferEngineApi(api_client)
    member_id = 56 # int | The id of the member
    store_id = 56 # int | The id of the store
    check_in_lat = 3.4 # float | The Latitude of the Store
    check_in_lng = 3.4 # float | The Latitude of the Store

    try:
        # Check-In Member to Store
        api_instance.check_in_member_to_store(member_id, store_id, check_in_lat, check_in_lng)
    except Exception as e:
        print("Exception when calling OfferEngineApi->check_in_member_to_store: %s\n" % e)

Parameters

Name	Type	Description
member_id	int	The id of the member
store_id	int	The id of the store
check_in_lat	float	The Latitude of the Store
check_in_lng	float	The Latitude of the Store

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 check in of member to store	* 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_offer_activities

OfferActivityList get_member_offer_activities(member_id)

Retrieve Offer Activities for Member

Example

Api Key Authentication (X-Auth-Token):

import time
import os
import sparkfly_client
from sparkfly_client.models.offer_activity_list import OfferActivityList
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.OfferEngineApi(api_client)
    member_id = 56 # int | The id of the member

    try:
        # Retrieve Offer Activities for Member
        api_response = api_instance.get_member_offer_activities(member_id)
        print("The response of OfferEngineApi->get_member_offer_activities:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OfferEngineApi->get_member_offer_activities: %s\n" % e)

Parameters

Name	Type	Description	Notes
member_id	int	The id of the member

Return type

OfferActivityList

Authorization

X-Auth-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful retrieval of offer activity	* 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_redemptions

RedemptionList get_member_redemptions(member_id)

Retrieve Redeemed Redemptions for Member

Example

Api Key Authentication (X-Auth-Token):

import time
import os
import sparkfly_client
from sparkfly_client.models.redemption_list import RedemptionList
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.OfferEngineApi(api_client)
    member_id = 56 # int | The id of the member

    try:
        # Retrieve Redeemed Redemptions for Member
        api_response = api_instance.get_member_redemptions(member_id)
        print("The response of OfferEngineApi->get_member_redemptions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OfferEngineApi->get_member_redemptions: %s\n" % e)

Parameters

Name	Type	Description	Notes
member_id	int	The id of the member

Return type

RedemptionList

Authorization

X-Auth-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful retrieval of redemptions	* 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_store

MemberStoreResponse get_member_store(member_id, store_id, x_channel_id)

Retrieve Store for Member

Example

Api Key Authentication (X-Auth-Token):

import time
import os
import sparkfly_client
from sparkfly_client.models.member_store_response import MemberStoreResponse
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.OfferEngineApi(api_client)
    member_id = 56 # int | The id of the member
    store_id = 56 # int | The id of the store
    x_channel_id = 56 # int | The id of the channel

    try:
        # Retrieve Store for Member
        api_response = api_instance.get_member_store(member_id, store_id, x_channel_id)
        print("The response of OfferEngineApi->get_member_store:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OfferEngineApi->get_member_store: %s\n" % e)

Parameters

Name	Type	Description
member_id	int	The id of the member
store_id	int	The id of the store
x_channel_id	int	The id of the channel

Return type

MemberStoreResponse

Authorization

X-Auth-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Store 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 -
404	Store 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_store_redemptions

RedemptionList get_member_store_redemptions(member_id, store_id)

Retrieve Redeemed Redemptions for Member for Store

Example

Api Key Authentication (X-Auth-Token):

import time
import os
import sparkfly_client
from sparkfly_client.models.redemption_list import RedemptionList
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.OfferEngineApi(api_client)
    member_id = 56 # int | The id of the member
    store_id = 56 # int | The id of the store

    try:
        # Retrieve Redeemed Redemptions for Member for Store
        api_response = api_instance.get_member_store_redemptions(member_id, store_id)
        print("The response of OfferEngineApi->get_member_store_redemptions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OfferEngineApi->get_member_store_redemptions: %s\n" % e)

Parameters

Name	Type	Description	Notes
member_id	int	The id of the member
store_id	int	The id of the store

Return type

RedemptionList

Authorization

X-Auth-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful retrieval of redemptions	* 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]

Files

OfferEngineApi.md

Latest commit

History

OfferEngineApi.md

File metadata and controls

sparkfly_client.OfferEngineApi

check_in_member_to_store

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_member_offer_activities

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_member_redemptions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_member_store

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_member_store_redemptions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details