module admin_api

Global Variables

• API_CALL_NUMBER_RETRY_ATTEMPTS
• MAX_COST_EXCEEDED_ERROR_CODE
• OPERATION_NAME_REQUIRED_ERROR_MESSAGE
• THROTTLED_ERROR_CODE
• WRONG_OPERATION_NAME_ERROR_MESSAGE

---

class Token

Abstract class for token objects.

This should never be extended, as you should either be using the OfflineTokenABC or the OnlineTokenABC.

---

property api_url

---

property model_extra

Get extra fields set during validation.

Returns: A dictionary of extra fields, or None if config.extra is not set to "allow".

---

property model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Returns: A set of strings representing the fields that have been set, i.e. that were not filled from defaults.

---

property oauth_url

---

method execute_gql

execute_gql(
    query: str,
    variables: Dict[str, Any] = {},
    operation_name: Optional[str] = None,
    suppress_errors: bool = False
) → Dict[str, Any]

---

method execute_rest

execute_rest(
    request: Request,
    endpoint: str,
    json: Optional[Dict[str, Any]] = None,
    debug: str = ''
) → Dict[str, Any]

---

method test_connection

test_connection() → bool

Test the connection to the Shopify Admin APIs.

---

class OfflineTokenABC

Offline tokens are used for long term access, and do not have a set expiry.

---

property api_url

---

property model_extra

Get extra fields set during validation.

Returns: A dictionary of extra fields, or None if config.extra is not set to "allow".

---

property model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Returns: A set of strings representing the fields that have been set, i.e. that were not filled from defaults.

---

property oauth_url

---

method execute_gql

execute_gql(
    query: str,
    variables: Dict[str, Any] = {},
    operation_name: Optional[str] = None,
    suppress_errors: bool = False
) → Dict[str, Any]

---

method execute_rest

execute_rest(
    request: Request,
    endpoint: str,
    json: Optional[Dict[str, Any]] = None,
    debug: str = ''
) → Dict[str, Any]

---

classmethod load

load(store_name: str)

---

method save

save()

---

method test_connection

test_connection() → bool

Test the connection to the Shopify Admin APIs.

---

class OnlineTokenABC

Online tokens are used to implement applications authenticated with a specific user's credentials.

These extend on the original token, adding in a user, its scope and an expiry time.

---

property api_url

---

property model_extra

Get extra fields set during validation.

Returns: A dictionary of extra fields, or None if config.extra is not set to "allow".

---

property model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Returns: A set of strings representing the fields that have been set, i.e. that were not filled from defaults.

---

property oauth_url

---

method execute_gql

execute_gql(
    query: str,
    variables: Dict[str, Any] = {},
    operation_name: Optional[str] = None,
    suppress_errors: bool = False
) → Dict[str, Any]

---

method execute_rest

execute_rest(
    request: Request,
    endpoint: str,
    json: Optional[Dict[str, Any]] = None,
    debug: str = ''
) → Dict[str, Any]

---

classmethod load

load(store_name: str, associated_user: str)

This method handles loading the token.

By default this does nothing, therefore the developer should override this.

---

method save

save()

This method handles saving the token.

By default this does nothing, therefore the developer should override this.

---

method test_connection

test_connection() → bool

Test the connection to the Shopify Admin APIs.

---

class PrivateTokenABC

Private token implementation, when we are pulling this from the config file.

Therefore we do not need the save function for the token class as there is no calls to the OAuth endpoints for shopify.

---

property api_url

---

property model_extra

Get extra fields set during validation.

Returns: A dictionary of extra fields, or None if config.extra is not set to "allow".

---

property model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Returns: A set of strings representing the fields that have been set, i.e. that were not filled from defaults.

---

property oauth_url

---

method execute_gql

execute_gql(
    query: str,
    variables: Dict[str, Any] = {},
    operation_name: Optional[str] = None,
    suppress_errors: bool = False
) → Dict[str, Any]

---

method execute_rest

execute_rest(
    request: Request,
    endpoint: str,
    json: Optional[Dict[str, Any]] = None,
    debug: str = ''
) → Dict[str, Any]

---

classmethod load

load(store_name: str)

This method handles loading the token.

By default this does nothing, therefore the developer should override this.

---

method test_connection

test_connection() → bool

Test the connection to the Shopify Admin APIs.

---

This file was automatically generated via lazydocs.