Skip to main content

No project description provided

Project description

stigg-api-client

⚠️ This package has been deprecated and is no longer actively maintained. Please use stigg-api-client-v2 instead.

This library provides a Python wrapper to Stigg's GraphQL API based on the operations that are in use by the Stigg's Node.js SDK.

It leverages the sgqlc library to generate Python classes for GraphQL types, and utilizes the sgqlc.endpoint.requests.RequestsEndpoint class to send the API requests. The responses are being automatically converted into native Python types.

Documentation

See https://docs.stigg.io/docs/python-sdk

Installation

pip install stigg-api-client

Usage

Initialize the client:

import os
from stigg import Stigg

api_key = os.environ.get("STIGG_SERVER_API_KEY")

stigg_client = Stigg.create_client(api_key)

Provision a customer

import os
from stigg import Stigg

api_key = os.environ.get("STIGG_SERVER_API_KEY")

client = Stigg.create_client(api_key)

data = client.request(Stigg.mutation.provision_customer, {
    "input": {
        "refId": "customer-id",
        "name": "Acme",
        "email": "hello@acme.com",
        "couponRefId": "coupon-id",
        "billingInformation": {
            "language": "en",
            "timezone": "America/New_York",
            "billingAddress": {
                "country": "US",
                "city": "New York",
                "state": "NY",
                "addressLine1": "123 Main Street",
                "addressLine2": "Apt. 1",
                "phoneNumber": "+1 212-499-5321",
                "postalCode": "10164"
            },
            "shippingAddress": {
                "country": "US",
                "city": "New York",
                "state": "NY",
                "addressLine1": "123 Main Street",
                "addressLine2": "Apt. 1",
                "phoneNumber": "+1 212-499-5321",
                "postalCode": "10164"
            }
        },
        "additionalMetaData": {
            "key": "value"
        },
        "subscriptionParams": {
            "planId": "plan-revvenu-basic"
        }
    }
})

print(data.provision_customer.customer.name)

Get a customer by ID

import os
from stigg import Stigg

api_key = os.environ.get("STIGG_SERVER_API_KEY")

client = Stigg.create_client(api_key)

data = client.request(Stigg.query.get_customer_by_id, {
  "input": {"customerId": "customer-id"}
})

customer = data.get_customer_by_ref_id
print(customer.name)

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

stigg_api_client-6.15.0.tar.gz (98.2 kB view details)

Uploaded Source

Built Distribution

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

stigg_api_client-6.15.0-py3-none-any.whl (99.5 kB view details)

Uploaded Python 3

File details

Details for the file stigg_api_client-6.15.0.tar.gz.

File metadata

  • Download URL: stigg_api_client-6.15.0.tar.gz
  • Upload date:
  • Size: 98.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.0 CPython/3.10.12 Linux/6.8.0-1059-azure

File hashes

Hashes for stigg_api_client-6.15.0.tar.gz
Algorithm Hash digest
SHA256 95fc1230792842a0b61e90cde564dd2d052e43bfb80de526b70558f5e0c781c0
MD5 977dfed46611a0eeb0737c4cf9761cb9
BLAKE2b-256 1dbd8171f4b5d9b85884ea47af821915433350f92b7496696ba3b995fe0ab4b7

See more details on using hashes here.

File details

Details for the file stigg_api_client-6.15.0-py3-none-any.whl.

File metadata

  • Download URL: stigg_api_client-6.15.0-py3-none-any.whl
  • Upload date:
  • Size: 99.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.0 CPython/3.10.12 Linux/6.8.0-1059-azure

File hashes

Hashes for stigg_api_client-6.15.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2cf1e323fe9e80b6871588012c18db78601abd3e025f67718ae2920b8825489b
MD5 2791f7478d8092d28e43ad47db7e5c90
BLAKE2b-256 89178d7b04f23840dc40ff6ed6f6b6696a57ac2d6fb7d94307276141acc99cdd

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