API Overview

Modules

• constants: These are the text error codes thrown by the GraphQL API. Although some errors
• exceptions
• token: Token constants.
• utils
• utils.domain
• utils.hmac
• utils.httpclient
• utils.misc
• utils.rest
• utils.shortuuid

Classes

• 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.ShopifyThrottledError: Exception to identify errors that are due to rate limit control
• token.AssociatedUser
• token.OfflineTokenABC: Offline tokens are used for long term access, and do not have a set expiry.
• token.OfflineTokenResponse
• token.OnlineTokenABC: Online tokens are used to implement applications that are authenticated with
• token.OnlineTokenResponse
• token.PrivateTokenABC: Private token implementation, when we are pulling this from the config file.
• token.Token: Abstract class for token objects. This should never be extended, as you
• token.WebhookResponse
• token.WebhookTopic: An enumeration.
• httpclient.HTTPClient
• rest.Method: An enumeration.
• rest.Request

Functions

• exceptions.not_our_fault: Simple function to identify invalid Shopify calls, i.e. our mistake.
• token.ISEOF
• token.ISNONTERMINAL
• token.ISTERMINAL
• token.is_webhook_valid
• domain.domain_to_storename
• domain.store_domain: Very flexible conversion of a shop's subdomain or complete or incomplete url into a
• hmac.calculate_from_components
• hmac.calculate_from_message
• hmac.validate
• misc.get_unique_id
• misc.now_epoch
• shortuuid.int_to_string: Convert a number to a string, using the given alphabet.
• shortuuid.random: Generate and return a cryptographically-secure short random string

---

This file was automatically generated via lazydocs.