sparkfly_client.OffersChannelsApi

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

Method	HTTP request	Description
delete_offer_channels	DELETE /v1.0/offers/{offer_id}/channels	Remove eligible Channels from offer
get_offer_channel	GET /v1.0/offers/{offer_id}/channels/{channel_id}	Eligible Channel Show
get_offer_channels	GET /v1.0/offers/{offer_id}/channels	Eligible Channels List
set_offer_channels	POST /v1.0/offers/{offer_id}/channels	Set eligible Channels for offer
update_offer_channel	PUT /v1.0/offers/{offer_id}/channels/{channel_id}	Eligible Channel Update
update_offer_channels	PUT /v1.0/offers/{offer_id}/channels	Add eligible Channels for offer

delete_offer_channels

OfferChannelsResponse delete_offer_channels(offer_id, offer_channel_ids_input_request=offer_channel_ids_input_request)

Remove eligible Channels from offer

Example

Api Key Authentication (X-Auth-Token):

import time
import os
import sparkfly_client
from sparkfly_client.models.offer_channel_ids_input_request import OfferChannelIdsInputRequest
from sparkfly_client.models.offer_channels_response import OfferChannelsResponse
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.OffersChannelsApi(api_client)
    offer_id = 56 # int | The id of the offer
    offer_channel_ids_input_request = sparkfly_client.OfferChannelIdsInputRequest() # OfferChannelIdsInputRequest | Channel IDs to remove from Offer (optional)

    try:
        # Remove eligible Channels from offer
        api_response = api_instance.delete_offer_channels(offer_id, offer_channel_ids_input_request=offer_channel_ids_input_request)
        print("The response of OffersChannelsApi->delete_offer_channels:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OffersChannelsApi->delete_offer_channels: %s\n" % e)

Parameters

Name	Type	Description	Notes
offer_id	int	The id of the offer
offer_channel_ids_input_request	OfferChannelIdsInputRequest	Channel IDs to remove from Offer	[optional]

Return type

OfferChannelsResponse

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]

get_offer_channel

EligibleChannelResponse get_offer_channel(offer_id, channel_id)

Eligible Channel Show

Example

Api Key Authentication (X-Auth-Token):

import time
import os
import sparkfly_client
from sparkfly_client.models.eligible_channel_response import EligibleChannelResponse
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.OffersChannelsApi(api_client)
    offer_id = 56 # int | The id of the offer
    channel_id = 56 # int | The id of the channel

    try:
        # Eligible Channel Show
        api_response = api_instance.get_offer_channel(offer_id, channel_id)
        print("The response of OffersChannelsApi->get_offer_channel:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OffersChannelsApi->get_offer_channel: %s\n" % e)

Parameters

Name	Type	Description	Notes
offer_id	int	The id of the offer
channel_id	int	The id of the channel

Return type

EligibleChannelResponse

Authorization

X-Auth-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Eligible Channel 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_offer_channels

OfferChannelsResponse get_offer_channels(offer_id)

Eligible Channels List

Example

Api Key Authentication (X-Auth-Token):

import time
import os
import sparkfly_client
from sparkfly_client.models.offer_channels_response import OfferChannelsResponse
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.OffersChannelsApi(api_client)
    offer_id = 56 # int | The id of the offer

    try:
        # Eligible Channels List
        api_response = api_instance.get_offer_channels(offer_id)
        print("The response of OffersChannelsApi->get_offer_channels:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OffersChannelsApi->get_offer_channels: %s\n" % e)

Parameters

Name	Type	Description	Notes
offer_id	int	The id of the offer

Return type

OfferChannelsResponse

Authorization

X-Auth-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Channels 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]

set_offer_channels

OfferChannelsResponse set_offer_channels(offer_id, offer_channel_ids_input_request=offer_channel_ids_input_request)

Set eligible Channels for offer

Example

Api Key Authentication (X-Auth-Token):

import time
import os
import sparkfly_client
from sparkfly_client.models.offer_channel_ids_input_request import OfferChannelIdsInputRequest
from sparkfly_client.models.offer_channels_response import OfferChannelsResponse
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.OffersChannelsApi(api_client)
    offer_id = 56 # int | The id of the offer
    offer_channel_ids_input_request = sparkfly_client.OfferChannelIdsInputRequest() # OfferChannelIdsInputRequest | Channel IDs to set to Offer (optional)

    try:
        # Set eligible Channels for offer
        api_response = api_instance.set_offer_channels(offer_id, offer_channel_ids_input_request=offer_channel_ids_input_request)
        print("The response of OffersChannelsApi->set_offer_channels:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OffersChannelsApi->set_offer_channels: %s\n" % e)

Parameters

Name	Type	Description	Notes
offer_id	int	The id of the offer
offer_channel_ids_input_request	OfferChannelIdsInputRequest	Channel IDs to set to Offer	[optional]

Return type

OfferChannelsResponse

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]

update_offer_channel

EligibleChannelResponse update_offer_channel(offer_id, channel_id, eligible_channel_input_request=eligible_channel_input_request)

Eligible Channel Update

Example

Api Key Authentication (X-Auth-Token):

import time
import os
import sparkfly_client
from sparkfly_client.models.eligible_channel_input_request import EligibleChannelInputRequest
from sparkfly_client.models.eligible_channel_response import EligibleChannelResponse
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.OffersChannelsApi(api_client)
    offer_id = 56 # int | The id of the offer
    channel_id = 56 # int | The id of the channel
    eligible_channel_input_request = sparkfly_client.EligibleChannelInputRequest() # EligibleChannelInputRequest | Eligible channel update (optional)

    try:
        # Eligible Channel Update
        api_response = api_instance.update_offer_channel(offer_id, channel_id, eligible_channel_input_request=eligible_channel_input_request)
        print("The response of OffersChannelsApi->update_offer_channel:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OffersChannelsApi->update_offer_channel: %s\n" % e)

Parameters

Name	Type	Description	Notes
offer_id	int	The id of the offer
channel_id	int	The id of the channel
eligible_channel_input_request	EligibleChannelInputRequest	Eligible channel update	[optional]

Return type

EligibleChannelResponse

Authorization

X-Auth-Token

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Successful update	* 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]

update_offer_channels

OfferChannelsResponse update_offer_channels(offer_id, offer_channel_ids_input_request=offer_channel_ids_input_request)

Add eligible Channels for offer

Example

Api Key Authentication (X-Auth-Token):

import time
import os
import sparkfly_client
from sparkfly_client.models.offer_channel_ids_input_request import OfferChannelIdsInputRequest
from sparkfly_client.models.offer_channels_response import OfferChannelsResponse
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.OffersChannelsApi(api_client)
    offer_id = 56 # int | The id of the offer
    offer_channel_ids_input_request = sparkfly_client.OfferChannelIdsInputRequest() # OfferChannelIdsInputRequest | Channel IDs to Add to Offer (optional)

    try:
        # Add eligible Channels for offer
        api_response = api_instance.update_offer_channels(offer_id, offer_channel_ids_input_request=offer_channel_ids_input_request)
        print("The response of OffersChannelsApi->update_offer_channels:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OffersChannelsApi->update_offer_channels: %s\n" % e)

Parameters

Name	Type	Description	Notes
offer_id	int	The id of the offer
offer_channel_ids_input_request	OfferChannelIdsInputRequest	Channel IDs to Add to Offer	[optional]

Return type

OfferChannelsResponse

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]

Files

OffersChannelsApi.md

Latest commit

History

OffersChannelsApi.md

File metadata and controls

sparkfly_client.OffersChannelsApi

delete_offer_channels

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_offer_channel

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_offer_channels

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

set_offer_channels

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_offer_channel

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_offer_channels

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details