API Overview

Modules

• admin_api
• constants
• exceptions
• hmac: HMAC (Keyed-Hashing for Message Authentication) module.
• multipass
• oauth
• oauth.exchange_token
• oauth.models
• oauth.signature_validation
• utils
• utils.domain
• utils.httpclient
• utils.jwtoken
• utils.misc
• utils.rest
• utils.shortuuid
• webhook
• webhook.graphql_queries

Classes

• admin_api.OfflineTokenABC: Offline tokens are used for long term access, and do not have a set expiry.
• admin_api.OnlineTokenABC: Online tokens are used to implement applications authenticated with a specific user's credentials.
• admin_api.PrivateTokenABC: Private token implementation, when we are pulling this from the config file.
• admin_api.Token: Abstract class for token objects.
• exceptions.FastAPIImportError: Exception to identify errors when spylip.oauth is accessed without fastapi installed.
• exceptions.ShopifyCallInvalidError: Exception to identify errors that our due to bad data sent by us.
• exceptions.ShopifyError: Exception to identify any Shopify error.
• exceptions.ShopifyExceedingMaxCostError: Exception to identify errors that are due to queries exceeding the max query size.
• exceptions.ShopifyGQLError: Exception to identify any Shopify admin graphql error.
• exceptions.ShopifyGQLUserError: Exception to identify any Shopify admin graphql error caused by the user mistake.
• exceptions.ShopifyIntermittentError: Exception to identify any Shopify admin API Intermittent error.
• exceptions.ShopifyInvalidResponseBody: Exception to identify when Shopify returned body is not the expected type, i.e. not a JSON.
• exceptions.ShopifyThrottledError: Exception to identify errors that are due to rate limit control.
• hmac.HMAC: RFC 2104 HMAC class. Also complies with RFC 4231.
• models.AssociatedUser: Shopify staff user associated with an online token.
• models.OfflineTokenModel: Read more about Offline access.
• models.OnlineTokenModel: Read more about Online access.
• httpclient.HTTPClient
• jwtoken.JWTBaseModel: Base class to manage JWT.
• misc.ElapsedTime
• misc.TimedResult
• rest.Method: An enumeration.
• rest.Request
• webhook.WebhookCreate: An enumeration.
• webhook.WebhookResponse
• webhook.WebhookTopic: An enumeration.

Functions

• exceptions.not_our_fault: Simple function to identify invalid Shopify calls, i.e. our mistake.
• hmac.calculate_from_components
• hmac.calculate_from_message
• hmac.digest: Fast inline implementation of HMAC.
• hmac.new: Create a new hashing object and return it.
• hmac.validate
• multipass.generate_token
• multipass.generate_url
• exchange_token.exchange_offline_token: Exchanges the temporary authorization code with Shopify for an offline token.
• exchange_token.exchange_online_token: Exchanges the temporary authorization code with Shopify for an online token.
• exchange_token.exchange_token: Exchanges the temporary authorization code with Shopify for a token.
• signature_validation.validate_signed_query_string: Validates that a query string has been signed by Shopify.
• domain.domain_to_storename
• domain.store_domain: Conversion of a shop's subdomain or complete or incomplete url into a complete url.
• misc.elapsed_time
• misc.get_unique_id
• misc.now_epoch
• misc.parse_scope
• shortuuid.int_to_string: Convert a number to a string, using the given alphabet.
• shortuuid.random: Generate a cryptographically-secure short random string of the specified length.
• webhook.create_event_bridge: Creates an Amazon EventBridge webhook subscription.
• webhook.create_http: Creates a HTTP webhook subscription.
• webhook.create_pub_sub: Creates a Google Cloud Pub/Sub webhook subscription.
• webhook.validate

---

This file was automatically generated via lazydocs.