checkbox_sdk package¶
Subpackages¶
- checkbox_sdk.client package
- Subpackages
- checkbox_sdk.client.api package
- Submodules
- checkbox_sdk.client.api.base module
- checkbox_sdk.client.api.branches module
- checkbox_sdk.client.api.cash_registers module
- checkbox_sdk.client.api.cashier module
- checkbox_sdk.client.api.currency module
- checkbox_sdk.client.api.extended_reports module
- checkbox_sdk.client.api.goods module
- checkbox_sdk.client.api.invoices module
- checkbox_sdk.client.api.nova_post module
- checkbox_sdk.client.api.orders module
- checkbox_sdk.client.api.organization module
- checkbox_sdk.client.api.prepayment_receipts module
- checkbox_sdk.client.api.receipts module
- checkbox_sdk.client.api.reports module
- checkbox_sdk.client.api.shifts module
- checkbox_sdk.client.api.tax module
- checkbox_sdk.client.api.transactions module
- checkbox_sdk.client.api.webhook module
- Module contents
- checkbox_sdk.client.api package
- Submodules
- checkbox_sdk.client.asynchronous module
- checkbox_sdk.client.base module
- checkbox_sdk.client.rate_limit module
- checkbox_sdk.client.synchronous module
- checkbox_sdk.client.utils module
- Module contents
- Subpackages
- checkbox_sdk.methods package
- Submodules
- checkbox_sdk.methods.base module
- checkbox_sdk.methods.branches module
- checkbox_sdk.methods.cash_register module
- checkbox_sdk.methods.cashier module
- checkbox_sdk.methods.currency module
- checkbox_sdk.methods.extended_reports module
- checkbox_sdk.methods.goods module
- checkbox_sdk.methods.invoices module
- checkbox_sdk.methods.nova_post module
- checkbox_sdk.methods.orders module
- checkbox_sdk.methods.organization module
- checkbox_sdk.methods.prepayment_receipts module
- checkbox_sdk.methods.receipts module
AddExternalCreateBulkReceiptsCreateCashWithdrawalReceiptCreateReceiptCreateReceiptOfflineCreateServiceReceiptCurrencyExchangeGetReceiptGetReceiptVisualizationGetReceiptVisualizationHtmlGetReceiptVisualizationPdfGetReceiptVisualizationPngGetReceiptVisualizationQrCodeGetReceiptVisualizationTextGetReceiptVisualizationXmlGetReceiptsGetReceiptsSearchSendEmailSendSMSServiceCurrency
- checkbox_sdk.methods.reports module
- checkbox_sdk.methods.shifts module
- checkbox_sdk.methods.tax module
- checkbox_sdk.methods.transactions module
- checkbox_sdk.methods.webhook module
- Module contents
- checkbox_sdk.storage package
- Submodules
- checkbox_sdk.storage.simple module
SessionStorageSessionStorage.tokenSessionStorage.license_keySessionStorage.machine_idSessionStorage.cashierSessionStorage.cash_registerSessionStorage.shiftSessionStorage.cash_registerSessionStorage.cashierSessionStorage.headersSessionStorage.license_keySessionStorage.machine_idSessionStorage.shiftSessionStorage.tokenSessionStorage.token_data
- Module contents
Submodules¶
checkbox_sdk.consts module¶
checkbox_sdk.constants¶
This module defines constants used throughout the checkbox-sdk package. These constants provide default values for API interaction, such as the base URL, API version, and request timing settings.
Constants:¶
BASE_API_URL: The base URL for the Checkbox API.
API_VERSION: The version of the Checkbox API to use.
DEFAULT_REQUEST_TIMEOUT: The default timeout for API requests, in seconds.
DEFAULT_REQUESTS_RELAX: The default delay between API requests, in seconds.
DEFAULT_RATE_LIMIT: The default rate limit in requests per 10 seconds.
- checkbox_sdk.consts.API_VERSION = '1'¶
The version of the Checkbox API to use.
This constant specifies the version of the API that the client is interacting with. It ensures compatibility with the API endpoints and their functionalities.
- checkbox_sdk.consts.BASE_API_URL = 'https://api.checkbox.in.ua'¶
The base URL for the Checkbox API.
This URL is used as the root endpoint for making API requests. It is a constant and does not change.
- checkbox_sdk.consts.DEFAULT_RATE_LIMIT = 15¶
The default rate limit for API requests.
This constant sets the default number of allowed requests in a 10-second period. It helps to manage API rate-limiting behavior and prevent overloading the server.
- checkbox_sdk.consts.DEFAULT_REQUESTS_RELAX = 0.75¶
The default delay between API requests.
- This value sets the default amount of time (in seconds) to wait between consecutive API requests to avoid
overloading the server or hitting rate limits.
- checkbox_sdk.consts.DEFAULT_REQUEST_TIMEOUT = 60¶
The default timeout for API requests.
This value sets the default amount of time (in seconds) to wait for an API request to complete before timing out. It helps to handle cases where the API might be slow to respond.
checkbox_sdk.exceptions module¶
- exception checkbox_sdk.exceptions.CheckBoxAPIError(status: int, content: Dict[str, Any], request_id: str | None = None)¶
Bases:
CheckBoxError
- exception checkbox_sdk.exceptions.CheckBoxAPIValidationError(*args, **kwargs)¶
Bases:
CheckBoxAPIError
- exception checkbox_sdk.exceptions.CheckBoxError¶
Bases:
Exception
- exception checkbox_sdk.exceptions.CheckBoxNetworkError¶
Bases:
CheckBoxError
- exception checkbox_sdk.exceptions.StatusException¶
Bases:
CheckBoxError
Module contents¶
checkbox-sdk¶
The checkbox-sdk package provides a Python client library for interacting with the Checkbox API. This package allows developers to easily integrate Checkbox services into their applications, manage authentication, handle various tasks, and interact with API endpoints using both synchronous and asynchronous methods.