Skip to content

Latest commit

 

History

History
325 lines (233 loc) · 14.2 KB

OffersPassbookConfigurationApi.md

File metadata and controls

325 lines (233 loc) · 14.2 KB
Raw

sparkfly_client.OffersPassbookConfigurationApi

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

Method HTTP request Description
create_offer_passbook_configuration POST /v1.0/offers/{offer_id}/passbook_configuration Passbook Configuration Create
delete_offer_passbook_configuration DELETE /v1.0/offers/{offer_id}/passbook_configuration Passbook Configuration Delete for Offer
get_offer_passbook_configuration GET /v1.0/offers/{offer_id}/passbook_configuration Get Passbook Configuration for Offer
update_offer_passbook_configuration PUT /v1.0/offers/{offer_id}/passbook_configuration Update Passbook Configuration for Offer

create_offer_passbook_configuration

PassbookConfigurationResponse create_offer_passbook_configuration(offer_id, passbook_configuration_input_request=passbook_configuration_input_request)

Passbook Configuration Create

Example

  • Api Key Authentication (X-Auth-Token):
import time
import os
import sparkfly_client
from sparkfly_client.models.passbook_configuration_input_request import PassbookConfigurationInputRequest
from sparkfly_client.models.passbook_configuration_response import PassbookConfigurationResponse
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.OffersPassbookConfigurationApi(api_client)
    offer_id = 56 # int | The id of the offer
    passbook_configuration_input_request = sparkfly_client.PassbookConfigurationInputRequest() # PassbookConfigurationInputRequest | Passbook Configuration to Create (optional)

    try:
        # Passbook Configuration Create
        api_response = api_instance.create_offer_passbook_configuration(offer_id, passbook_configuration_input_request=passbook_configuration_input_request)
        print("The response of OffersPassbookConfigurationApi->create_offer_passbook_configuration:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OffersPassbookConfigurationApi->create_offer_passbook_configuration: %s\n" % e)

Parameters

Name Type Description Notes
offer_id int The id of the offer
passbook_configuration_input_request PassbookConfigurationInputRequest Passbook Configuration to Create [optional]

Return type

PassbookConfigurationResponse

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_offer_passbook_configuration

delete_offer_passbook_configuration(offer_id)

Passbook Configuration Delete for Offer

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.OffersPassbookConfigurationApi(api_client)
    offer_id = 56 # int | The id of the offer

    try:
        # Passbook Configuration Delete for Offer
        api_instance.delete_offer_passbook_configuration(offer_id)
    except Exception as e:
        print("Exception when calling OffersPassbookConfigurationApi->delete_offer_passbook_configuration: %s\n" % e)

Parameters

Name Type Description Notes
offer_id int The id of the offer

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
201 Successful deletion * Cache-Control -
* Content-Length -
* Content-Type -
* Date -
* Etag -
* Location -
* 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]

get_offer_passbook_configuration

PassbookConfigurationResponse get_offer_passbook_configuration(offer_id)

Get Passbook Configuration for Offer

Example

  • Api Key Authentication (X-Auth-Token):
import time
import os
import sparkfly_client
from sparkfly_client.models.passbook_configuration_response import PassbookConfigurationResponse
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.OffersPassbookConfigurationApi(api_client)
    offer_id = 56 # int | The id of the offer

    try:
        # Get Passbook Configuration for Offer
        api_response = api_instance.get_offer_passbook_configuration(offer_id)
        print("The response of OffersPassbookConfigurationApi->get_offer_passbook_configuration:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OffersPassbookConfigurationApi->get_offer_passbook_configuration: %s\n" % e)

Parameters

Name Type Description Notes
offer_id int The id of the offer

Return type

PassbookConfigurationResponse

Authorization

X-Auth-Token

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Passbook Configuration 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_offer_passbook_configuration

PassbookConfigurationResponse update_offer_passbook_configuration(offer_id, passbook_configuration_input_request=passbook_configuration_input_request)

Update Passbook Configuration for Offer

Example

  • Api Key Authentication (X-Auth-Token):
import time
import os
import sparkfly_client
from sparkfly_client.models.passbook_configuration_input_request import PassbookConfigurationInputRequest
from sparkfly_client.models.passbook_configuration_response import PassbookConfigurationResponse
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.OffersPassbookConfigurationApi(api_client)
    offer_id = 56 # int | The id of the offer
    passbook_configuration_input_request = sparkfly_client.PassbookConfigurationInputRequest() # PassbookConfigurationInputRequest | Passbook Configuration to Update (optional)

    try:
        # Update Passbook Configuration for Offer
        api_response = api_instance.update_offer_passbook_configuration(offer_id, passbook_configuration_input_request=passbook_configuration_input_request)
        print("The response of OffersPassbookConfigurationApi->update_offer_passbook_configuration:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OffersPassbookConfigurationApi->update_offer_passbook_configuration: %s\n" % e)

Parameters

Name Type Description Notes
offer_id int The id of the offer
passbook_configuration_input_request PassbookConfigurationInputRequest Passbook Configuration to Update [optional]

Return type

PassbookConfigurationResponse

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]