Core Operations

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for growth-operations-jasper from gravatar.com growth-operations-jasper

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT
  • Author: Sparkfly Support Team
  • Tags OpenAPI , OpenAPI-Generator , Core Operations
  • Requires: Python >=3.9
Report project as malware

Project description

sparkfly

The Sparkfly Platform provides a full lifecycle for promotions and rewards from creation to distribution to settlement. The platform integrates in real-time at the point-of-sale and provides item level discounting and tracking. The capabilities of the Sparkfly Platform are available through the use of the Sparkfly Platform API.

The Sparkfly documentation site is under development. If the documentation you're after isn't available here, please contact support@sparkfly.com and we will get you what you need.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0
  • Package version: 1.2.1
  • Generator version: 7.14.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://help.sparkfly.com/

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import sparkfly

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import sparkfly

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import sparkfly
from sparkfly.rest import ApiException
from pprint import pprint

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

# 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: XAuthToken
configuration.api_key['XAuthToken'] = os.environ["API_KEY"]

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


# Enter a context with an instance of the API client
async with sparkfly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sparkfly.AudiencesApi(api_client)
    audience_id = 'audience_id_example' # str | audience to find or modify

    try:
        # Remove an Audience
        await api_instance.delete_audiences_id(audience_id)
    except ApiException as e:
        print("Exception when calling AudiencesApi->delete_audiences_id: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api-staging.sparkfly.com/v1.0

Class Method HTTP request Description
AudiencesApi delete_audiences_id DELETE /audiences/{audience_id} Remove an Audience
AudiencesApi delete_audiences_id_sub_audiences_sub_audience_id DELETE /audiences/{audience_id}/sub_audiences/{sub_audience_id} Remove a Sub-Audience
AudiencesApi get_audiences GET /audiences List all Audiences
AudiencesApi get_audiences_id GET /audiences/{audience_id} Retrieve an Audience
AudiencesApi get_audiences_id_sub_audiences GET /audiences/{audience_id}/sub_audiences List all Sub-Audiences
AudiencesApi get_audiences_id_sub_audiences_sub_audience_id GET /audiences/{audience_id}/sub_audiences/{sub_audience_id} Retrieve a Sub-Audience
AudiencesApi post_audiences POST /audiences Create an Audience
AudiencesApi post_audiences_id_sub_audiences POST /audiences/{audience_id}/sub_audiences Create a Sub-Audience
AudiencesApi put_audiences_id PUT /audiences/{audience_id} Update an Audience
AudiencesApi put_audiences_id_sub_audiences_sub_audience_id PUT /audiences/{audience_id}/sub_audiences/{sub_audience_id} Update a Sub-Audience
AuthenticationApi post_auth POST /auth Request an Authentication Token
BIStoreListsApi get_merchants_bi_store_lists GET /merchants/bi_store_lists List all BI Store Lists
CampaignsApi get_campaign GET /campaigns/{campaign_id} Retrieve a Campaign by Campaign ID
CampaignsApi get_campaign_tags GET /campaigns/tags Retrieve Campaign Tags
CampaignsApi get_campaigns GET /campaigns List all Campaigns
CampaignsApi post_campaign POST /campaigns Create a Campaign
CampaignsApi put_campaign PUT /campaigns/{campaign_id} Update a Campaign by Campaign ID
CampaignsApi put_campaigns_campaign_id_actions_approve PUT /campaigns/{campaign_id}/actions/{action} Set a Campaign's Status
CtmApi get_ctm_custom_messages GET /v2/ctm/customposmessages CTM Custom Messages
CtmApi get_ctm_store GET /v2/ctm/stores CTM Stores
CtmApi get_show_ctm GET /ctm/members/{site_id}/{credential} CTM Show Response
CtmApi post_allocate_ctm POST /ctm/allocate/{site_id}/{credential} CTM Allocate
CtmApi post_deallocate_ctm POST /ctm/deallocate/{site_id} CTM Dealocate
CtmApi post_qitems_ctm POST /ctm/qitems/{site_id}/{credential} CTM Qitems
CtmApi post_update_ctm POST /v2/ctm/members/{site_id}/{credential} CTM Update Response
CtmApi post_update_ctm_siteid POST /v2/ctm/members/{site_id} CTM Update Response
CtmApi put_show_ctm PUT /v2/ctm/members/{site_id}/{credential} CTM Show Response
CtmApi put_transaction_update_ctm PUT /ctm/members/{site_id} CTM Transaction Update
CtmApi put_update_ctm PUT /ctm/members/{site_id}/{credential} CTM Update Response
EligibleItemSetsApi delete_offers_offer_id_eligible_item_sets_id DELETE /offers/{offer_id}/eligible_item_sets/{id} Remove an Eligible Item Set
EligibleItemSetsApi get_offers_offer_id_eligible_item_sets GET /offers/{offer_id}/eligible_item_sets List all Eligible Item Sets
EligibleItemSetsApi get_offers_offer_id_eligible_item_sets_id GET /offers/{offer_id}/eligible_item_sets/{id} Get an Eligible Item Set
EligibleItemSetsApi post_offers_offer_id_eligible_item_sets POST /offers/{offer_id}/eligible_item_sets Create an Eligible Item Set
EligibleItemSetsApi put_offers_offer_id_eligible_item_sets_id PUT /offers/{offer_id}/eligible_item_sets/{id} Update an Eligible Item Set
EmailOptInApi post_optins POST /optins Email Opt In
EventNotificationsApi create_callback POST /event_notifications/callbacks Create Callback
EventNotificationsApi create_subscription POST /event_notifications/subscriptions Create Subscription
EventNotificationsApi delete_callback DELETE /event_notifications/callbacks/{callback_id} Delete Callback
EventNotificationsApi delete_subscription DELETE /event_notifications/subscriptions/{subscription_id} Delete Subscription
EventNotificationsApi get_callback GET /event_notifications/callbacks/{callback_id} Get Callback by ID
EventNotificationsApi get_subscription GET /event_notifications/subscriptions/{subscription_id} Get Subscription by ID
EventNotificationsApi list_callbacks GET /event_notifications/callbacks List Callbacks
EventNotificationsApi list_subscriptions GET /event_notifications/subscriptions List Subscriptions
ImpressionsApi delete_impressions_id DELETE /impressions/{id} Delete an Impression
ImpressionsApi get_impressions GET /impressions List Impressions
ImpressionsApi post_impressions POST /impressions Create an Impression
ItemsApi delete_item_sets_item_set_id DELETE /item_sets/{item_set_id} Delete an Item Set
ItemsApi delete_item_sets_item_set_id_items_id DELETE /item_sets/{item_set_id}/items/{id} Remove Item from Set
ItemsApi delete_items_id DELETE /items/{id} Delete Item
ItemsApi get_item_sets GET /item_sets Item Set Index
ItemsApi get_item_sets_item_set_id GET /item_sets/{item_set_id} Get an Item Set
ItemsApi get_item_sets_item_set_id_items GET /item_sets/{item_set_id}/items Item Set Item Index
ItemsApi get_items GET /items Item Index
ItemsApi get_items_id GET /items/{id} Get Item
ItemsApi post_item_sets POST /item_sets Item Set Create
ItemsApi post_item_sets_item_set_id_items_id POST /item_sets/{item_set_id}/items/{id} Add Item to Set
ItemsApi post_items POST /items Create Item
ItemsApi put_item_sets_item_set_id PUT /item_sets/{item_set_id} Update an Item Set
ItemsApi put_items_id PUT /items/{id} Update Item
MemberPrivacyApi get_privacy_member_export GET /privacy/member/export Exports Data Associated with a Member
MemberPrivacyApi post_privacy_member_delete_request POST /privacy/member/delete_request Creates a Deletion Request for a Member
MembersApi delete_members_member_id DELETE /members/{member_id} Remove a Member
MembersApi get_members GET /members List Members
MembersApi get_members_member_id GET /members/{member_id} Find a Member
MembersApi get_members_profile GET /members/{id}/profile Retrieve a Member Profile
MembersApi get_members_search GET /members/search Search for a Member
MembersApi post_members POST /members Create a Member
MembersApi post_members_profile POST /members/{id}/profile Create/Update a Member Profile
MembersApi put_members_member_id PUT /members/{member_id} Update a Member
OfferListsApi delete_offer_lists_offer_list_id DELETE /offer_lists/{offer_list_id} Remove an Offer List
OfferListsApi get_offer_lists GET /offer_lists List all Offer Lists
OfferListsApi get_offer_lists_offer_list_id GET /offer_lists/{offer_list_id} Retrieve an Offer List
OfferListsApi post_offer_lists POST /offer_lists Create an Offer List
OfferListsApi put_offer_lists_offer_list_id PUT /offer_lists/{offer_list_id} Update an Offer List
OfferPOSOfferCodesApi delete_offers_offer_id_pos_offer_codes_id DELETE /offers/{offer_id}/pos_offer_codes/{id} Remove an Offer POS Offer Code
OfferPOSOfferCodesApi get_offers_offer_id_pos_offer_codes GET /offers/{offer_id}/pos_offer_codes List all Offer POS Offer Codes
OfferPOSOfferCodesApi get_offers_offer_id_pos_offer_codes_id GET /offers/{offer_id}/pos_offer_codes/{id} Get an Offer POS Offer Code
OfferPOSOfferCodesApi post_offers_offer_id_pos_offer_codes POST /offers/{offer_id}/pos_offer_codes Create an Offer POS Offer Code
OfferPOSOfferCodesApi put_offers_offer_id_pos_offer_codes_id PUT /offers/{offer_id}/pos_offer_codes/{id} Update an Offer POS Offer Code
OfferStatesApi get_members_member_id_offer_states GET /members/{member_id}/offer_states Get all Offer States
OfferStatesApi get_members_member_id_offer_states_offer_state_id GET /members/{member_id}/offer_states/{offerstate_id} Get Offer State by Offer State ID
OfferStatesApi get_members_member_id_offers_offer_id GET /members/{member_id}/offers/{offer_id} Get Offer State by Offer ID
OfferStatesApi get_members_offer_states GET /members/offer_states Get Offer State from Query Parameters
OfferStatesApi post_members_id_offer_states_issue POST /members/offer_states/issue Issue an Offer to a member (high throughput)
OfferStatesApi post_members_member_id_offer_states POST /members/{member_id}/offer_states Create Offer State
OfferStatesApi post_members_member_id_offer_states_offerstate_id POST /members/{member_id}/offer_states/{offerstate_id} Update Offer State - Post
OfferStatesApi post_members_member_id_offer_states_offerstate_id_void POST /members/{member_id}/offer_states/{offerstate_id}/void Void Offer State
OfferStatesApi post_members_member_id_offer_states_offerstate_id_voidmember_identifier_member_identifier POST /members/offer_states/{offerstate_id}/void Void Offer State by Member Identifier
OfferStatesApi post_members_offer_states POST /members/offer_states Create Offer State from Query Parameters
OfferStatesApi put_members_member_id_offer_states_offer_state_id PUT /members/{member_id}/offer_states/{offerstate_id} Update Offer State
OffersApi delete_offers_offer_id DELETE /offers/{offer_id} Delete an Offer
OffersApi get_offers GET /offers List all Offers
OffersApi get_offers_offer_id GET /offers/{offer_id} Find an Offer
OffersApi post_offers POST /offers Create an Offer
OffersApi put_offers_offer_id PUT /offers/{offer_id} Update an Offer
POSOfferCodesApi get_pos_offer_codes GET /pos_offer_codes List all POS Offer Codes
POSOfferCodesApi get_pos_offer_codes_id GET /pos_offer_codes/{id} Get a POS Offer Code
StoreListsApi delete_merchants_merchant_id_store_lists_store_list_id DELETE /merchants/{merchant_id}/store_lists/{store_list_id} Remove a Store List
StoreListsApi get_merchants_merchant_id_store_lists GET /merchants/{merchant_id}/store_lists List all Store Lists
StoreListsApi get_merchants_merchant_id_store_lists_store_list_id GET /merchants/{merchant_id}/store_lists/{store_list_id} Retrieve a Store List
StoreListsApi post_merchants_merchant_id_store_lists POST /merchants/{merchant_id}/store_lists Create a Store List
StoreListsApi put_merchants_merchant_id_store_lists_store_list_id PUT /merchants/{merchant_id}/store_lists/{store_list_id} Update a Store List
StoresApi delete_merchants_merchant_id_stores_store_id DELETE /merchants/{merchant_id}/stores/{store_id} Remove a Store
StoresApi get_merchants_merchant_id_stores GET /merchants/{merchant_id}/stores List all Stores
StoresApi get_merchants_merchant_id_stores_index GET /merchants/stores/index List all Stores with Active Offers
StoresApi get_merchants_merchant_id_stores_store_id GET /merchants/{merchant_id}/stores/{store_id} Retrieve a Store
StoresApi post_merchants_merchant_id_stores POST /merchants/{merchant_id}/stores Create a Store
StoresApi put_merchants_merchant_id_stores_store_id PUT /merchants/{merchant_id}/stores/{store_id} Update a Store
TemplatesApi get_templates GET /templates Get all Templates

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

XAuthToken

  • Type: API key
  • API key parameter name: X-Auth-Token
  • Location: HTTP header

XAuthIdentity

  • Type: API key
  • API key parameter name: X-Auth-Identity
  • Location: HTTP header

XAuthKey

  • Type: API key
  • API key parameter name: X-Auth-Key
  • Location: HTTP header

Author

support@sparkfly.com

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for growth-operations-jasper from gravatar.com growth-operations-jasper

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT
  • Author: Sparkfly Support Team
  • Tags OpenAPI , OpenAPI-Generator , Core Operations
  • Requires: Python >=3.9

Release history Release notifications | RSS feed

1.4.9

1.4.8

1.4.7

1.4.6

1.4.5

1.4.4

1.4.3

1.4.2

1.4.1

1.4.0

1.3.7

1.3.5

1.3.4

1.3.3

1.3.2

1.3.1

1.3.0

1.2.3

1.2.2

This version

1.2.1

1.2.0

1.1.19

1.1.18

1.1.17

1.1.16

1.1.15

1.1.14

1.1.13

1.1.12

1.1.11

1.1.10

1.1.9

1.1.8

1.1.7

1.1.6

1.1.5

1.1.4

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sparkfly-1.2.1.tar.gz (147.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sparkfly-1.2.1-py3-none-any.whl (842.3 kB view details)

Uploaded Python 3

File details

Details for the file sparkfly-1.2.1.tar.gz.

File metadata

  • Download URL: sparkfly-1.2.1.tar.gz
  • Upload date:
  • Size: 147.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for sparkfly-1.2.1.tar.gz
Algorithm Hash digest
SHA256 6eb88ffcdbe64607f0bb622cc5a2a79b73eedca9c2ca3a69c65c30e8c3780939
MD5 d2c69aab97cac6dce97ec6c8e46dd151
BLAKE2b-256 f45da854c3681069e1aacd2f2d165cc49faa00717ce6281528a864c4e0d4b9d4

See more details on using hashes here.

File details

Details for the file sparkfly-1.2.1-py3-none-any.whl.

File metadata

  • Download URL: sparkfly-1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 842.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for sparkfly-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a2d66979517570841e57eb366dbf722d15ee13ed0c051d9d57b0ede9647131d4
MD5 bded0ae14147c6c413ada2994feb5f7f
BLAKE2b-256 e849dfa53c577fdede55b71772b49157da568bcf482b7cf8927316c0d3f320e6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page